home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / latex209 / contrib / ucthesis / ucthesis.readme (.txt) < prev   
LaTeX Document  |  1994-12-09  |  9KB  |  174 lines
  1. This is the README file for the UCTHESIS style for LaTeX.  It
  2. corresponds to version 2.7 of the UCTHESIS style (30 October 1994).
  3. ========================
  4. Using the UCTHESIS style
  5. ========================
  6. Sample File
  7. -----------
  8. There is a sample dissertation (by the fictitious, but very
  9. irritating, Perry H Disdainful) in the file uctest.tex.  It also uses
  10. uctest.bib as its bibliography database (though the contents of the
  11. database are not important).  Mostly this is useful as an example of
  12. how to produce the front matter.  If you don't understand LaTeX at
  13. all, this file might help you get started, but, since you're going to
  14. be writing a 100+ page document, you should invest the $20 in a copy
  15. of the LaTeX manual (by Leslie Lamport).
  16. Choosing the UCTHESIS style
  17. ---------------------------
  18. To use the UCTHESIS style, make sure that the ucthesis.sty file is on
  19. your TEXINPUTS search path and use the following command at the start
  20. of your input file:
  21. \documentstyle{ucthesis}
  22. ============================
  23. What the UCTHESIS style does
  24. ============================
  25. The UCTHESIS style is a modified version of the standard LaTeX REPORT
  26. style that is accepted for use with University of California PhD
  27. dissertations and Masters theses.  The available commands are almost
  28. identical to those of the REPORT style, so your best starting point
  29. for documentation is the LaTeX manual written by Leslie Lamport.
  30. The key features of the style are:
  31. 1) The primary modification to the REPORT style is the use of
  32. pseudo-double-spacing, since the UC system's rules are still designed
  33. for typewriters.  This is achieved by increasing the \baselinestretch
  34. parameter to 1.37.  The \baselinestretch is returned to a
  35. single-spaced value of 1.00 for elements like tables, captions, and
  36. footnotes and for all displayed text (quote, quotation, and verse
  37. environments).  Unfortunately, this is done with a macro called \ssp
  38. which resets the font size to \normalsize.  In LaTeX 2.09 this seems
  39. to be unavoidable, but it makes it very hard to create tables in
  40. different font sizes.
  41. 2) Margins are 1.5 inches on the left, 1.0 inches elsewhere.
  42. 3) Uses 11 point by default; you can use the 10pt or 12pt options for
  43. those sizes.
  44. 4) Page numbers are in the top right corner for all pages.
  45. 5) Complete, correct front matter for UC dissertations can be
  46. generated.  If you are not a UC student, you should make sure that the
  47. front matter is OK with your school.
  48. Optional Styles
  49. ---------------
  50. There are four primary optional styles:
  51. The "draft" style uses single-spacing throughout the document.
  52. The "10pt", "11pt", and "12pt" styles set the default font size to the
  53. obvious value.  The "11pt" option is the default and thus is
  54. redundant, but is safe to use anyway.
  55. Page Headers
  56. ------------
  57. If you want to use page headers or footers other than the default
  58. ones, you should try using "headerfooter.sty" or "fancyheadings.sty".
  59. The myheadings pagestyle doesn't work well and there is no workaround.
  60. The headerfooter and fancyheadings styles are widely distributed, well
  61. documented, and easy to use.
  62. ============
  63. Front matter
  64. ============
  65. The other key service provided by this style is that it generates
  66. correct front matter (title page, approval page, abstract, etc.) with
  67. a failrly simple set of commands.  This facility could be a little
  68. easier, but compared to an earlier state of affairs, it's pretty
  69. slick.  The format of the front matter is specified quite explicitly
  70. in the document "Guidelines for Submitting a Doctoral Dissertation or
  71. Master's Thesis" distributed by the UC Berkeley Graduate Division.
  72. The current version of the style is based on the April 1994 version of
  73. this document.  Someday, someone may get the guidelines to be written
  74. in terms of laser printers and computers, rather than for typewriters.
  75. A complete example of the use of the front matter commands can be
  76. found in the sample dissertation distributed with the style.
  77. Declarations
  78. ------------
  79. To use the front matter macros and environments, you must first
  80. declare a number of text strings:
  81. \title        Dissertation title
  82. \author        Your name as registered with UC (usually w/ full
  83.         middle name)
  84. \degreeyear    Year your dissertation will be granted
  85. \degree        The title of your degree (e.g. Doctor of Philosophy)
  86. \chair        Title and name of your committee chair
  87.         (e.g. "Professor Michael A. Harrison")
  88. \othermembers    The names of the other members of your committee
  89.         separated by linebreaks
  90.         (e.g. "Professor Susan L. Graham\\Professor Jim Pitman)
  91. \numberofmembers The number of members on your committee.  This defaults to
  92.         3 (and thus is optional) and can be any value between
  93.         3 and 6.  It affects the number of lines on the approval
  94.         page and the space between them.
  95. \prevdegrees    Your previous degrees
  96.         "B.A. (University of California, San Diego) 1978\\
  97.         B.A. (University of California, San Diego) 1986\\
  98.         M.S. (University of California, Berkeley) 1989"
  99. \field        The official title of your field.  This is usually
  100.         your department's name, but at Berkeley, most
  101.         Engineering degrees have a more complex name.
  102.         Be sure to check the guidelines for any special
  103.         twists on the name of your field.
  104. \campus        The name of your UC campus.  This should be capitalized.
  105.         (e.g. Berkeley)
  106. Title, Approval, and Copyright pages
  107. ------------------------------------
  108. The title, approval, and copyright pages have extremely rigid formats
  109. that allow them to be generated automatically once the above
  110. declarations have been made.  To generate them, invoke the macros
  111.     \maketitle
  112.     \approvalpage
  113.     \copyrightpage
  114. You should probably invoke them in that order, because that's the
  115. order required by the guidelines.
  116. Abstract Environment
  117. --------------------
  118. Because you have to provide the text of the abstract, only the title
  119. can be generated automatically.  So, there is an abstract environment.
  120. It generates the title and numbers the abstract in arabic numerals and
  121. makes sure that it starts on new page.
  122. The UC system requires that your advisor sign the last page of your
  123. abstract.  Many students just let their advisor just sign at a random
  124. location on the page, but you can use the \abstractsignature command
  125. to generate a signature line with your advisor's name printed below
  126. it.  This command generates the signature line at the point it is
  127. invoked, so it should be placed at the end of the abstract.
  128. Other Front Matter
  129. ------------------
  130. The remaining front matter (dedication, table of contents, lists of
  131. figures and tables, acknowledgements) MUST be put inside the
  132. "frontmatter" environment, which ensures that page-numbering is
  133. handled properly.  Within this frontmatter environment, you put the
  134. environments and commands for the rest of the front matter.  There are
  135. environments for "dedication" and "acknowledgements" and the standard
  136. LaTeX commands for producing \tableofcontents, \listoffigures, and
  137. \listoftables.  
  138. The standard LaTeX commands are well documented in the LaTeX manual.
  139. You will probably have to hand edit the .lof (list of figures) and
  140. .lot (list of tables) files to make verbose captions more suitable for
  141. this front matter.  Once you do this, remember to use the \nofiles
  142. macro to keep them from getting overwritten.
  143. The acknowledgements and dedication environments make their contents
  144. start on a new page.  The acknowledgements environment also put the
  145. word "Acknowledgements" in large, bold, centered text at the top of
  146. the page.  For formatting the dedication page, you're on your own.
  147. After all, the dedication is a kind of poetry and there's no
  148. predicting the right way to format poetry.
  149. =====================================================
  150. Other commands not found in the standard report style
  151. =====================================================
  152. The "smalltabular" and "smalltabular*" environments are equivalent to
  153. the "tabular" and "tabular*" environments, except that they use the
  154. \small font.  The "scriptsizetabular" and "scriptsizetabular*" use the
  155. \scriptsize font.
  156. =============================
  157. Installing the UCTHESIS style
  158. =============================
  159. To install the UCTHESIS style, you need to install four files:
  160.     ucthesis.doc
  161.     uct10.doc
  162.     uct11.doc
  163.     uct12.doc
  164. in your LaTeX style file repository.  For LaTeX to load them properly,
  165. you need to create matching files with the .sty extension.  There are
  166. two easy ways to do this:
  167. 1) rename each of the files, so that ucthesis.doc becomes
  168. ucthesis.sty, uct10.doc becomes uct10.sty, etc.
  169. 2) make soft links with the correct names that point to the .doc
  170. files.
  171. An alternative that we use at Berkeley is to install the full
  172. distribution in a ucthesis subdirectory of the style file directory
  173. and then make soft links that point to the .doc files in the subdirectory.
  174.